.TH WLR-DPMS 1 2024-01-30
.SH NAME
wlr-dpms \- change output power modes in wlroots compositors
.SH SYNOPSIS
.B wlr-dpms
.RB [ on | off | toggle | query ] 
.RI [ output ]...
.SH DESCRIPTION
.P
\fBwlr-dpms\fR sets or gets the power mode of outputs on compositors
which support the 'wlr-output-power-management-unstable-v1' protocol.
Outputs are not turned back on automatically on activity, a separate
tool (like \fBswayidle\fP(1)\fR) must be used for this functionality.
.SH OPERATIONS
.TP
.BR on ", " off
Set the power mode to on or off, respectively.
.TP
.B toggle
Toggle the power mode.  This is the default if no operation
is specified.
.TP
.B query
Print the power mode.
.SH OUTPUTS
.P
Each \fIoutput\fR specifies the name of an output operate on (which
can be obtained through \fBwlr\-randr\fR).
If no \fIoutput\fR is specified, operate on all detected outputs.
If a specified \fIoutput\fR isn't detected, it is ignored.
If no specified \fIoutput\fR is detected, a warning is printed
to standard error.
.SH EXAMPLES
Toggle the power mode of all detected outputs:
.P
.EX
    $ wlr-dpms
.EE
.P
Turn all detected outputs off:
.P
.EX
    $ wlr-dpms off
.EE
.P
Turn on outputs \fBHDMI\-A\-1\fR and \fBeDP\fR:
.P
.EX
    $ wlr-dpms on HDMI\-A\-1 eDP
.EE
.P
Toggle output \fBeDP\fR:
.P
.EX
    $ wlr-dpms eDP
.EE
.P
Get the power mode of outputs \fBDP\-2\fR and \fBDP\-3\fR:
.P
.EX
    $ wlr-dpms query DP-2 DP-3
    DP-2 on
    DP-3 off
.EE
.SH "EXIT STATUS"
.TP
0
if OK,
.TP
1
if allocating memory failed at any point in the program,
.TP
2
if connecting to a display failed,
.TP
3
if getting the display registry failed,
.TP
4
if getting an output name during a query operation failed.
.SH AUTHOR
.P
Created by Daniel Semyonov, licensed under MIT.
.P
The 'wlr-output-power-management-unstable-v1' protocol was created by
Purism SPC.
.SH BUGS
Report bugs at <https://todo.sr.ht/~dsemy/wlr-dpms>.
.SH "SEE ALSO"
\fBswayidle\fP(1)\fR, \fBwlr-randr \-\-help
